<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.5) on Mon Sep 12 08:35:19 CEST 2016 -->
    <title>MongoAuth (Groovy Documentation)</title>
    <meta name="date" content="2016-09-12">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="MongoAuth (Groovy Documentation)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/auth/mongo/MongoAuth" target="_top">Frames</a></li>
            <li><a href="MongoAuth.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>io.vertx.groovy.ext.auth.mongo</strong></div>

    <h2 title="[Groovy] Class MongoAuth" class="title">[Groovy] Class MongoAuth</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li>io.vertx.groovy.ext.auth.mongo.MongoAuth
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">



    <p> An extension of AuthProvider which is using  as store
</p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        
        <!-- ======== CONSTRUCTOR SUMMARY ======== -->
        <ul class="blockList">
                <li class="blockList"><a name="constructor_summary"><!--   --></a>
                    <h3>Constructor Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
                        <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Constructor and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst">
                                <code><a href="#MongoAuth(java.lang.Object)">MongoAuth</a></strong>
                                (java.lang.Object delegate)</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
        </ul>
        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#create(io.vertx.groovy.ext.mongo.MongoClient, Map<String, Object>)">create</a></strong>(<a href='../../../../../../io/vertx/groovy/ext/mongo/MongoClient.html'>MongoClient</a> mongoClient, java.util.Map&lt;java.lang.String, java.lang.Object&gt; config)</code><br>Creates an instance of MongoAuth by using the given  and configuration object. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getCollectionName()">getCollectionName</a></strong>()</code><br>The name of the collection used to store User objects inside. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.Object</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDelegate()">getDelegate</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html'>HashStrategy</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#getHashStrategy()">getHashStrategy</a></strong>()</code><br>The HashStrategy which is used by the current instance</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getPasswordCredentialField()">getPasswordCredentialField</a></strong>()</code><br>Get the name of the field to be used as property for the password of credentials in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getPasswordField()">getPasswordField</a></strong>()</code><br>Get the name of the field to be used for the password Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a></td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getPermissionField()">getPermissionField</a></strong>()</code><br>Get the name of the field to be used for the permissions. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getRoleField()">getRoleField</a></strong>()</code><br>Get the name of the field to be used for the roles. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getSaltField()">getSaltField</a></strong>()</code><br>Get the name of the field to be used for the salt. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getUsernameCredentialField()">getUsernameCredentialField</a></strong>()</code><br>Get the name of the field to be used as property for the username in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getUsernameField()">getUsernameField</a></strong>()</code><br>Get the name of the field to be used for the username. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#insertUser(java.lang.String, java.lang.String, List<String>, List<String>, Handler<AsyncResult<String>>)">insertUser</a></strong>(java.lang.String username, java.lang.String password, java.util.List&lt;java.lang.String&gt; roles, java.util.List&lt;java.lang.String&gt; permissions, io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;java.lang.String&gt;&gt; resultHandler)</code><br>Insert a new user into mongo in the convenient way</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setCollectionName(java.lang.String)">setCollectionName</a></strong>(java.lang.String collectionName)</code><br>Set the name of the collection to be used. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setHashStrategy(io.vertx.groovy.ext.auth.mongo.HashStrategy)">setHashStrategy</a></strong>(<a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html'>HashStrategy</a> hashStrategy)</code><br>The HashStrategy which is used by the current instance</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setPasswordCredentialField(java.lang.String)">setPasswordCredentialField</a></strong>(java.lang.String fieldName)</code><br>Set the name of the field to be used as property for the password of credentials in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setPasswordField(java.lang.String)">setPasswordField</a></strong>(java.lang.String fieldName)</code><br>Set the name of the field to be used for the password Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a></td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setPermissionField(java.lang.String)">setPermissionField</a></strong>(java.lang.String fieldName)</code><br>Set the name of the field to be used for the permissions. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setRoleField(java.lang.String)">setRoleField</a></strong>(java.lang.String fieldName)</code><br>Set the name of the field to be used for the roles. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setSaltField(java.lang.String)">setSaltField</a></strong>(java.lang.String fieldName)</code><br>Set the name of the field to be used for the salt. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setUsernameCredentialField(java.lang.String)">setUsernameCredentialField</a></strong>(java.lang.String fieldName)</code><br>Set the name of the field to be used as property for the username in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#setUsernameField(java.lang.String)">setUsernameField</a></strong>(java.lang.String fieldName)</code><br>Set the name of the field to be used for the username. </td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>class <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html'>AuthProvider</a></strong></code></td>
                            <td class="colLast"><code><a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate(Map<String, Object>, Handler<AsyncResult<User>>)'>authenticate</a>, <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#getDelegate()'>getDelegate</a></code></td>
                        </tr>
                        <tr class="altColor">
                            <td class="colFirst"><code>class java.lang.Object</strong></code></td>
                            <td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            
            <!-- =========== CONSTRUCTOR DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="constructor_detail">
                    <!--   -->
                </a>
                    <h3>Constructor Detail</h3>
                    
                        <a name="MongoAuth(java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><strong>MongoAuth</strong>(java.lang.Object delegate)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="create(io.vertx.groovy.ext.mongo.MongoClient, Map<String, Object>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>create</strong>(<a href='../../../../../../io/vertx/groovy/ext/mongo/MongoClient.html'>MongoClient</a> mongoClient, java.util.Map&lt;java.lang.String, java.lang.Object&gt; config)</h4>
                                <p> Creates an instance of MongoAuth by using the given  and configuration object. An example for a
 configuration object:
 
 <pre>
 JsonObject js = new JsonObject();
 js.put(MongoAuth.PROPERTY_COLLECTION_NAME, createCollectionName(MongoAuth.DEFAULT_COLLECTION_NAME));
 </pre>
   <DL><DT><B>Returns:</B></DT><DD>the created instance of <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>s</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>mongoClient</code> -  an instance of  to be used for data storage and retrival</DD><DD><code>config</code> -  the configuration object for the current instance. By this</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getCollectionName()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getCollectionName</strong>()</h4>
                                <p> The name of the collection used to store User objects inside. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the collectionName</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getDelegate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.Object <strong>getDelegate</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="getHashStrategy()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html'>HashStrategy</a> <strong>getHashStrategy</strong>()</h4>
                                <p> The HashStrategy which is used by the current instance
   <DL><DT><B>Returns:</B></DT><DD>the defined instance of <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html' title='HashStrategy'>HashStrategy</a></DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getPasswordCredentialField()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getPasswordCredentialField</strong>()</h4>
                                <p> Get the name of the field to be used as property for the password of credentials in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the passwordCredentialField</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getPasswordField()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getPasswordField</strong>()</h4>
                                <p> Get the name of the field to be used for the password Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the passwordField</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getPermissionField()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getPermissionField</strong>()</h4>
                                <p> Get the name of the field to be used for the permissions. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>.
 Permissions are expected to be saved as JsonArray
   <DL><DT><B>Returns:</B></DT><DD>the permissionField</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getRoleField()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getRoleField</strong>()</h4>
                                <p> Get the name of the field to be used for the roles. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>. Roles are expected to
 be saved as JsonArray
   <DL><DT><B>Returns:</B></DT><DD>the roleField</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getSaltField()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getSaltField</strong>()</h4>
                                <p> Get the name of the field to be used for the salt. Only used when <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html#setSaltStyle' title='HashStrategy.setSaltStyle'>HashStrategy.setSaltStyle</a> is
 set to
   <DL><DT><B>Returns:</B></DT><DD>the saltField</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getUsernameCredentialField()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getUsernameCredentialField</strong>()</h4>
                                <p> Get the name of the field to be used as property for the username in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the usernameCredentialField</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getUsernameField()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.String <strong>getUsernameField</strong>()</h4>
                                <p> Get the name of the field to be used for the username. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the usernameField</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="insertUser(java.lang.String, java.lang.String, List<String>, List<String>, Handler<AsyncResult<String>>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>void <strong>insertUser</strong>(java.lang.String username, java.lang.String password, java.util.List&lt;java.lang.String&gt; roles, java.util.List&lt;java.lang.String&gt; permissions, io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;java.lang.String&gt;&gt; resultHandler)</h4>
                                <p> Insert a new user into mongo in the convenient way
   <DL><DT><B>Parameters:</B></DT><DD><code>username</code> -  the username to be set</DD><DD><code>password</code> -  the passsword in clear text, will be adapted following the definitions of the defined <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html' title='HashStrategy'>HashStrategy</a></DD><DD><code>roles</code> -  a list of roles to be set</DD><DD><code>permissions</code> -  a list of permissions to be set</DD><DD><code>resultHandler</code> -  the ResultHandler will be provided with the id of the generated record</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setCollectionName(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setCollectionName</strong>(java.lang.String collectionName)</h4>
                                <p> Set the name of the collection to be used. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>collectionName</code> -  the name of the collection to be used for storing and reading user data</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setHashStrategy(io.vertx.groovy.ext.auth.mongo.HashStrategy)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setHashStrategy</strong>(<a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html'>HashStrategy</a> hashStrategy)</h4>
                                <p> The HashStrategy which is used by the current instance
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>hashStrategy</code> -  the <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html' title='HashStrategy'>HashStrategy</a> to be set</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setPasswordCredentialField(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setPasswordCredentialField</strong>(java.lang.String fieldName)</h4>
                                <p> Set the name of the field to be used as property for the password of credentials in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>fieldName</code> -  the name of the field to be used</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setPasswordField(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setPasswordField</strong>(java.lang.String fieldName)</h4>
                                <p> Set the name of the field to be used for the password Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>fieldName</code> -  the name of the field to be used</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setPermissionField(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setPermissionField</strong>(java.lang.String fieldName)</h4>
                                <p> Set the name of the field to be used for the permissions. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>.
 Permissions are expected to be saved as JsonArray
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>fieldName</code> -  the name of the field to be used</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setRoleField(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setRoleField</strong>(java.lang.String fieldName)</h4>
                                <p> Set the name of the field to be used for the roles. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>. Roles are expected to
 be saved as JsonArray
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>fieldName</code> -  the name of the field to be used</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setSaltField(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setSaltField</strong>(java.lang.String fieldName)</h4>
                                <p> Set the name of the field to be used for the salt. Only used when <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/HashStrategy.html#setSaltStyle' title='HashStrategy.setSaltStyle'>HashStrategy.setSaltStyle</a> is
 set to
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>fieldName</code> -  the name of the field to be used</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setUsernameCredentialField(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setUsernameCredentialField</strong>(java.lang.String fieldName)</h4>
                                <p> Set the name of the field to be used as property for the username in the method
 <a href='../../../../../../io/vertx/groovy/ext/auth/AuthProvider.html#authenticate' title='AuthProvider.authenticate'>AuthProvider.authenticate</a>. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>fieldName</code> -  the name of the field to be used</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="setUsernameField(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html'>MongoAuth</a> <strong>setUsernameField</strong>(java.lang.String fieldName)</h4>
                                <p> Set the name of the field to be used for the username. Defaults to <a href='../../../../../../io/vertx/groovy/ext/auth/mongo/MongoAuth.html' title='MongoAuth'>MongoAuth</a>
   <DL><DT><B>Returns:</B></DT><DD>the current instance itself for fluent calls</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>fieldName</code> -  the name of the field to be used</DD></DL></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../../index.html?io/vertx/groovy/ext/auth/mongo/MongoAuth" target="_top">Frames</a></li>
            <li><a href="MongoAuth.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>